ultrasonic3.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef ULTRASONIC3_H
#define ULTRASONIC3_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
#include "drv_pwm.h"




#define ULTRASONIC3_PWM_DEF_FREQ                32767
#define ULTRASONIC3_PWM_DEF_DC                  0.5

#define ULTRASONIC3_SET_DATA_SAMPLE_EDGE        SET_SPI_DATA_SAMPLE_EDGE
#define ULTRASONIC3_SET_DATA_SAMPLE_MIDDLE      SET_SPI_DATA_SAMPLE_MIDDLE
 // ultrasonic3_set



#define ULTRASONIC3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.pwm  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 // ultrasonic3_map // ultrasonic3

typedef struct
{
    digital_out_t int_pin_out;      
    digital_in_t int_pin_in;        
 
    pin_name_t int_pin_name;        
 
    spi_master_t spi;               
    pwm_t pwm;                      
 
    uint32_t pwm_freq;              
    pin_name_t chip_select;         
 
} ultrasonic3_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
 
    // Additional gpio pins
    pin_name_t pwm;                 
    pin_name_t int_pin;             
 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
    uint32_t dev_pwm_freq;          
 
} ultrasonic3_cfg_t;

typedef enum
{
    ULTRASONIC3_OK = 0,
    ULTRASONIC3_ERROR = -1
 
} ultrasonic3_return_value_t;


void ultrasonic3_cfg_setup ( ultrasonic3_cfg_t *cfg );

err_t ultrasonic3_init ( ultrasonic3_t *ctx, ultrasonic3_cfg_t *cfg );

err_t ultrasonic3_default_cfg ( ultrasonic3_t *ctx );

err_t ultrasonic3_set_duty_cycle ( ultrasonic3_t *ctx, float duty_cycle );

err_t ultrasonic3_pwm_stop ( ultrasonic3_t *ctx );

err_t ultrasonic3_pwm_start ( ultrasonic3_t *ctx );

void ultrasonic3_get_measurements ( void );
 
#ifdef __cplusplus
}
#endif
#endif // ULTRASONIC3_H
 // ultrasonic3
 
// ------------------------------------------------------------------------ END